Getting Started

Introduction

This document will guide you through the steps to set up your development environment and start contributing to the project.

Prerequisites

Before starting, ensure you have the following:

• Access Requirements:

  • Jira
  • Bitbucket
  • Confluence
  • AOK Team Access
  • Keycloak

• Hardware Requirements:

  • Mac computer/Windows for Android development.

• Software Requirements:

  • Android Studio
  • Java
  • Git
  • Postman

Setting Up Development Environment

To get started, clone below repositories to your local machine:

BaseApp (NavidaPro)

https://dev.azure.com/aok-plus/navida/_git/navida-pro-fe-plugins-android

git clone https://aok-plus@dev.azure.com/aok-plus/navida/_git/navida-pro-fe-plugins-android

OpenContract

https://dev.azure.com/aok-plus/navida/_git/navida-pro-fe-open-contract-android

git clone https://aok-plus@dev.azure.com/aok-plus/navida/_git/navida-pro-fe-open-contract-android

Configuration

As open contract will be added as a depedency to the plugins app, this will be hosted in the Azure artifacts and will be picked up from the dependencies. Inorder to facilitate that, we need to have the following things in place.

Create a azure-configs.properties in your root project level and add in the following details

azureMavenAccessToken=YOUR_PERSONAL_ACCESS_TOKEN 
userName=YOUR_AZURE_USER_NAME
repositoryUrl=https://pkgs.dev.azure.com/aok-plus/_packaging/navida-frontend/maven/v1

Replace the following azureMavenAccessToken & userName with your credentials. PAT is available here https://dev.azure.com/aok-plus/_usersSettings/tokens

You need to create a token with below access

1. Build(read)
2. Code(read)
3. Packaging(read & write)
4. Pipeline Resources(Use)
5. Variable Groups(Read)
6. Wiki(Read)

Setting Java

After cloning the repo, go to android studio's setting --> Build, Execution, Deployment --> Build Tools --> Gradle, install JDK version 17, 11 by Open JDK.

After installing all the version of JDK then select 17 version and click apply.

Run command in terminal if you are running in a mac machine
export JAVA_HOME=/Applications/Android\ Studio.app/Contents/jbr/Contents/Home

This will temporarily set the JAVA_HOME. Alternatively you can set it permanently by adding it in bash profile. If you are running in windows, you need to add in the environment variables. https://www3.ntu.edu.sg/home/ehchua/programming/howto/Environment_Variables.html

Recordings

You can go through the recording of the standard guidelines here